4176 customizing reminder message to partner #5093

Sukhpreet-s · 2025-03-12T19:24:39Z

Resolves #4176

Description

This PR adds functionality to include a customized message in the reminder email sent to partners. A rich text input field is added to the Organization edit form. It also allows interpolation for partner_name as a variable in the customized message similar to default_email_text field.

The following components are added/updated:

reminder_email_text rich text field is added to the Organization model.
The form field is added to the edit and show details Organization files.
The reminder_email_text is displayed in both html and text versions of the notify_deadline email.

Looking for feedback:

I allowed interpolation only for partner_name variable in the customized message as none of the other values made sense to include. Is there any other value that need to be allowed here, like deadline_day?
The plain text version of the email looks like below. It contains some HTML comments.

Screenshot

I've followed the DistributionMailer.partner_mailer implementation and noticed that even the DistributionMailer has the same behaviour for the plain text version of the email. I wonder if this only happens in development environment for debugging purposes... 🤔? I've opened an issue describing it in details and trying to find a fix for this.

Type of change

New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Wrote test case to verify if the custom message is included in the email text when it is added by the org admin.

Also tested manually. Here are the steps:

Sign in as org admin.
Open org profile by clicking "My Organization" in the sidebar.
Edit the profile by clicking "Edit" button at the bottom of the page.
Add some text in "Reminder Email Content" input field and save.
Since this email is sent via a job that runs daily at some set time, it is convenient to execute the Mailer function directly from the rails console using the following set of commands:
- Execute rails console from terminal: bundle exec rails console
- Get associated partner: partner = Partner.find_by_name("<Enter name of any Partner connected to your Org>")
- Send email: ReminderDeadlineMailer.notify_deadline(partner).deliver_now
The email should be sent and can be accessed from tmp/letter_opener folder in the project locally.

Screenshots

Example screenshot of the email:

The first sentence in the following screenshot is the custom reminder message.

Input field in Organization profile edit page:

Reminder email text in Organization profile details page:

Documentation update:

cielf

Hey @Sukpreet-s

Thank you for picking this up!

It works well. I'd like to make some adjustments so that it's easier for the users, though.

1/ Please move the field in Organizations to just below the reminder deadline field.

2/ Let's also change the label on it to "Additional text for reminder email." This will make it clearer that it isn't a total replacement of the reminder email text.

3/ Let's put the custom content in the email just above the 'Please contact...'

This issue was created before we wrote the user guide -- we're going to need to make some updates there as well -- are you comfortable with drafting those changes?

Sukhpreet-s · 2025-03-13T19:05:39Z

Thank you for the review! ✨ I'll make the requested changes.

This issue was created before we wrote the user guide -- we're going to need to make some updates there as well -- are you comfortable with drafting those changes?

Sure thing 💯 I looked around the docs and it seems like the changes need to go here 💭 Is that right or am I missing some other spot in the docs?

cielf · 2025-03-13T20:49:39Z

Pretty sure that's the only spot. Thanks!

Sukhpreet-s · 2025-03-14T19:45:45Z

@cielf The changes are ready for review. The screenshots are updated in the description above for reference.

Also, I noticed the organization edit and show pages are also shown for superuser ([email protected]).

Based on the current setup, the superusers can see reminder_email_text but cannot edit it -- Is this okay? or do we want them to be able to edit it as well? 🤔

cielf · 2025-03-14T22:34:56Z

As it happens, we've got a draft issue waiting regarding removing the superuser's ability to change organization settings that the org can change themselves, so I think it's ok.

…e-to-partner

cielf

The user guide is very new and rough -- unfortunately you ran into an uncaught issue with it -- the bits that look like code in that text should be a bit more user-friendly.

Other than that I'm quite happy with this functionally -- I'm passing it on to our senior tech folk for input.

Thanks again!

cielf · 2025-03-15T22:28:58Z

docs/user_guide/bank/getting_started_customization.md

 Please log into Human Essentials at https://humanessentials.app before this date and submit your request if you are intending to submit an essentials request.
-
+<br/>
+<br/>
 Please contact [Your bank's name] at <%= @organization.email %>


Ok -- I didn't realize we still had something so ... codey... in this.

Please change <%= @organization.email %> to [ Your bank's email]

cielf · 2025-03-15T22:29:03Z

docs/user_guide/bank/getting_started_customization.md

-
+<br/>
+<br/>
+<%= @organization.reminder_email_text %>


and then change this to [Additional text for reminder email (see below)]

cielf · 2025-03-15T22:30:53Z

docs/user_guide/bank/getting_started_customization.md

@@ -76,6 +81,9 @@ If you do not pick a day, no reminder emails are sent.
 #### Deadline day (Final day of the month to submit Requests)
 This day will be included in the reminder email message,

+#### Additional text for reminder email
+If present, this text will be included in the reminder email placed at the end of the email. In the above email template, this additional message is placed in the position of `<%= @organization.reminder_email_text %>`.
+


If present, this text will be included in the reminder email after the default text. In the above email template, this additional message will replace [Additional text for reminder email (see below)].

Addressed

cielf

LGTM

Sukhpreet-s added 2 commits March 11, 2025 16:34

Add reminder email text field to organizations

c2538e9

Allow partner name interpolation in reminder email

43c1b3e

cielf self-requested a review March 13, 2025 16:39

cielf requested changes Mar 13, 2025

View reviewed changes

Sukhpreet-s added 3 commits March 13, 2025 23:13

Update the placement of the reminder text

cbb6252

Update docs with additional text for reminder email

65dae79

Fix linting issue

02d9889

Merge branch 'rubyforgood:main' into 4176-customizing-reminder-messag…

5b96e1e

…e-to-partner

Sukhpreet-s mentioned this pull request Mar 15, 2025

[BUG]: Rendering rich text fields in plain text email includes HTML comments and tags #5098

Open

3 tasks

cielf previously requested changes Mar 15, 2025

View reviewed changes

cielf requested review from awwaiid and dorner March 15, 2025 22:38

Update reminder email docs by simplifying the placeholders

e4c4b53

Sukhpreet-s requested a review from cielf March 16, 2025 05:44

cielf reviewed Mar 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

4176 customizing reminder message to partner #5093

4176 customizing reminder message to partner #5093

Sukhpreet-s commented Mar 12, 2025 •

edited

Loading

cielf left a comment •

edited

Loading

Sukhpreet-s commented Mar 13, 2025

cielf commented Mar 13, 2025

Sukhpreet-s commented Mar 14, 2025

cielf commented Mar 14, 2025

cielf left a comment

cielf Mar 15, 2025

cielf Mar 15, 2025

cielf Mar 15, 2025

cielf left a comment

4176 customizing reminder message to partner #5093

Are you sure you want to change the base?

4176 customizing reminder message to partner #5093

Conversation

Sukhpreet-s commented Mar 12, 2025 • edited Loading

Description

Looking for feedback:

Type of change

How Has This Been Tested?

Screenshots

cielf left a comment • edited Loading

Choose a reason for hiding this comment

Sukhpreet-s commented Mar 13, 2025

cielf commented Mar 13, 2025

Sukhpreet-s commented Mar 14, 2025

cielf commented Mar 14, 2025

cielf left a comment

Choose a reason for hiding this comment

cielf Mar 15, 2025

Choose a reason for hiding this comment

cielf Mar 15, 2025

Choose a reason for hiding this comment

cielf Mar 15, 2025

Choose a reason for hiding this comment

cielf left a comment

Choose a reason for hiding this comment

Sukhpreet-s commented Mar 12, 2025 •

edited

Loading

cielf left a comment •

edited

Loading